(* Copyright (C) 2015-2016 Bloomberg Finance L.P.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * In addition to the permissions granted to you by the LGPL, you may combine
 * or link a "work that uses the Library" with a publicly distributed version
 * of this file to produce a combined library or application, then distribute
 * that combined work under the terms of your choosing, with no requirement
 * to comply with the obligations normally placed on you by section 4 of the
 * LGPL version 3 (or the corresponding section of a later version of the LGPL
 * should you choose to use a later version).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)

(** Based on [hash_set] specialized for mask operations  *)

type t

val create : int -> t

(* add one Ident.t
   Ident.t is unmasked by default *)
val add_unmask : t -> Ident.t -> unit

val mask_and_check_all_hit : t -> Ident.t -> bool
(** [check_mask h key] if [key] exists mask it otherwise nothing
    return true if all keys are masked otherwise false *)

val iter_and_unmask : t -> f:(Ident.t -> bool -> unit) -> unit
(** [iter_and_unmask ~f h] iterates over the collection and masks all idents,
    Warning: don't consult the collection in function [f], since its state will
    not be consistent.
    TODO: what happens if an exception raised in the callback,
    would the hashtbl still be in consistent state? *)
